VObject::DispatchEvents

Section: ET++ method description (n)
Updated: automatically Mon Apr 8 20:17:57 1991
Index Return to Main Contents

NAME

VObject::DispatchEvents - instance method

TEMPLATE

commandToPerform = Command * DispatchEvents(Point locatorPoint, Token inputToken, Clipper * focusClipper)

SPECIFIERS

public virtual

DESCRIPTION

DispatchEvents is called by the method Input if the VObject is enabled and contains the locatorPoint (see method ContainsPoint).
DispatchEvents examines the inputToken and dispatches the events to the corresponding event handling methods (the methods with a name like Do...Command).
The command returned by the method DoLeftButtonDownCommand and the method DoMiddleButtonDownCommand is not immediately returned unless it is gNoChanges. It is assumed to be a mouse tracking command. With that command the method TrackInContent of the focusClipper is called which starts mouse tracking.
If the mouse has just entered or exited the area occupied by the VObject or one of the mouse buttons has been clicked then the mouse cursor shape is changed to that returned by the method GetCursor.
VObjects with childs should override this method and call the method Input for every child which in turn will invoke this method. This is done, for example, by the class CompositeVObject.
See technote 'Event Handling'. Method is sometimes overridden.

ARGUMENTS

Point locatorPoint: contains the position of the mouse cursor at the time of the event. The locatorPoint is always automatically transformed into the VObject's coordinate system.
Token inputToken: contains the whole information about the event. In contrast to the locatorPoint the Pos member of the class Token is never transformed into local coordinate systems. A copy of the inputToken can always be found in the var gToken.
Clipper * focusClipper: the Clipper that currently has the input focus

RETURN ARGUMENT

Command * commandToPerform: contains a command to be executed by one of the next event handlers which is usually a Document (see method Document::PerformCommand). If the inputToken is not handled then gNoChanges is returned.

FIRST DEFINITION

class VObject

FILES

implementation:: VObject.C

This document was created by man2html, using the manual pages.
Time: 00:40:22 GMT, March 30, 2022